<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Source: vertx.js</title>
    
    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">
    
    <h1 class="page-title">Source: vertx.js</h1>
    
    


    
    <section>
        <article>
            <pre class="prettyprint source"><code>/*
 * Copyright 2011-2012 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

if (typeof __vertxload === 'string') {
  throw "Use require() to load Vert.x API modules"
}

/**
 * The 'vertx' module provides all of the vertx API namespaced 
 * under 'vertx'. For example:
 *
 * @example
 * var vertx  = require('vertx');
 * var buff   = new vertx.Buffer('some string');
 * var bus    = vertx.eventBus;
 * var client = vertx.http.createHttpClient();
 *
 * // Each of the modules imported by vertx may also be required as 
 * //individual modules. For example:
 *
 * var http   = require('vertx/http');
 * var server = http.createHttpServer();
 * var client = http.createHttpClient();
 *
 * var Buffer = require('vertx/buffer');
 * var buff   = new Buffer('another string');
 *
 * @exports vertx
 */
var vertx = {};

/** 
 * The vert.x Buffer class. 
 * @see module:vertx/buffer~Buffer
 * */
vertx.Buffer = require('vertx/buffer');

/**
 * The vert.x distributed event bus.
 * @see module:vertx/event_bus
 */
vertx.eventBus = require('vertx/event_bus');

/**
 * The vert.x net module
 * @see module:vertx/net
 */
vertx.net = require('vertx/net');

/**
 * The vert.x http module
 * @see module:vertx/http
 */
vertx.http = require('vertx/http');

/**
 * The vert.x stream pump.
 * @see module:vertx/pump~Pump
 */
vertx.Pump = require('vertx/pump');

/**
 * The vert.x timer module
 * @see module:vertx/timer
 */
vertx.timer = require('vertx/timer');

// TODO: Document and test this
vertx.sockJS = require('vertx/sockjs');

/**
 * The vert.x parseTools module
 * @see module:vertx/parse_tools
 */
vertx.parseTools = require('vertx/parse_tools');

/**
 * The vert.x sharedData module
 * @see module:vertx/shared_data
 */
vertx.sharedData = require('vertx/shared_data');

/**
 * The vert.x fileSystem module
 * @see module:vertx/file_system
 */
vertx.fileSystem = require('vertx/file_system');

/**
 * Put the task on the event queue for this loop so it will be run asynchronously
 * immediately after this event is processed.
 *
 * @param {Handler} handler The handler to be called
 */
vertx.runOnContext = function(task) {
  __jvertx.runOnContext(task);
}

vertx.currentContext = function() {
  return __jvertx.currentContext();
}

// For compatability with functions that aren't namespaced to the module.
// For example: `vertx.createHttpServer()` instead of the namespaced
// version `vertx.http.createHttpServer()`.
// These are not documented any longer, and may be deprecated some day.
function addProps(obj) {
  for (var key in obj) {
    if (obj.hasOwnProperty(key)) {
      vertx[key] = obj[key];
    }
  }
}
addProps(vertx.net);
addProps(vertx.http);
addProps(vertx.timer);
addProps(vertx.sockJS);
addProps(vertx.parseTools);
addProps(vertx.sharedData);
addProps(vertx.fileSystem);

module.exports = vertx;

// JSDoc @typedef declarations go here. This is primarily a documentation
// convenience that allows us to document named types for things that don't
// really have names in this API, e.g. a RequestHandler

/**
 * Vert.x makes heavy use of callback handlers in the API. A basic handler is
 * simply a function that is called when vert.x events are fired, and expects
 * no parameters.
 *
 * @see module:vertx.runOnContext
 * @typedef {function} Handler
 */


</code></pre>
        </article>
    </section>




</div>

<nav>
    <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-vertx.html">vertx</a></li><li><a href="buffer.html">vertx/buffer</a></li><li><a href="console.html">vertx/console</a></li><li><a href="container.html">vertx/container</a></li><li><a href="event_bus.html">vertx/event_bus</a></li><li><a href="file_system.html">vertx/file_system</a></li><li><a href="http.html">vertx/http</a></li><li><a href="multi_map.html">vertx/multi_map</a></li><li><a href="net.html">vertx/net</a></li><li><a href="parse_tools.html">vertx/parse_tools</a></li><li><a href="pump.html">vertx/pump</a></li><li><a href="shared_data.html">vertx/shared_data</a></li><li><a href="sockjs.html">vertx/sockjs</a></li><li><a href="timer.html">vertx/timer</a></li></ul><h3>Externals</h3><ul><li><a href="InetSocketAddress.html">InetSocketAddress</a></li><li><a href="Buffer_.html">Buffer</a></li><li><a href="RecordParser.html">RecordParser</a></li><li><a href="SockJSSocket.html">SockJSSocket</a></li></ul><h3>Classes</h3><ul><li><a href="buffer-Buffer.html">Buffer</a></li><li><a href="file_system.AsyncFile.html">AsyncFile</a></li><li><a href="http.HttpClient.html">HttpClient</a></li><li><a href="http.HttpClientRequest.html">HttpClientRequest</a></li><li><a href="http.HttpClientResponse.html">HttpClientResponse</a></li><li><a href="http.HttpServer.html">HttpServer</a></li><li><a href="http.HttpServerFileUpload.html">HttpServerFileUpload</a></li><li><a href="http.HttpServerRequest.html">HttpServerRequest</a></li><li><a href="http.HttpServerResponse.html">HttpServerResponse</a></li><li><a href="http.RouteMatcher.html">RouteMatcher</a></li><li><a href="http.WebSocket.html">WebSocket</a></li><li><a href="multi_map-MultiMap.html">MultiMap</a></li><li><a href="net.NetClient.html">NetClient</a></li><li><a href="net.NetServer.html">NetServer</a></li><li><a href="net.NetSocket.html">NetSocket</a></li><li><a href="pump-Pump.html">Pump</a></li><li><a href="sockjs.SockJSServer.html">SockJSServer</a></li></ul><h3>Mixins</h3><ul><li><a href="ClientSSLSupport.html">ClientSSLSupport</a></li><li><a href="ReadStream.html">ReadStream</a></li><li><a href="ServerSSLSupport.html">ServerSSLSupport</a></li><li><a href="ServerTCPSupport.html">ServerTCPSupport</a></li><li><a href="SSLSupport.html">SSLSupport</a></li><li><a href="TCPSupport.html">TCPSupport</a></li><li><a href="WriteStream.html">WriteStream</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>

<br clear="both">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Wed Jul 17 2013 20:27:22 GMT+0100 (BST)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>